Roundcube Framework
\

\

Classes

html Class for HTML code creation
html_button Class to create HTML button
html_checkbox Class to create HTML checkboxes
html_hiddenfield Class to create an hidden HTML input field
html_inputfield Class to create an HTML input field
html_passwordfield Class to create an HTML password field
html_radiobutton Class to create HTML radio buttons
html_select Builder for HTML drop-down menus Syntax:<pre> // create instance. arguments are used to set attributes of select-tag $select = new html_select(['name' => 'fieldname']);
html_table Class to build an HTML table
html_textarea Class to create an HTML textarea
rcube Base class of the Roundcube Framework implemented as singleton
rcube_addressbook Abstract skeleton of an address book/repository
rcube_addresses Collected addresses database
rcube_base_replacer Helper class to turn relative urls into absolute ones using a predefined base
rcube_browser Provide details about the client's browser based on the User-Agent header
rcube_cache Interface class for accessing Roundcube cache
rcube_cache_apc Interface implementation class for accessing APC cache
rcube_cache_db Interface implementation class for accessing SQL Database cache
rcube_cache_memcache Interface implementation class for accessing Memcache cache
rcube_cache_memcached Interface implementation class for accessing Memcached cache
rcube_cache_redis Interface implementation class for accessing Redis cache
rcube_charset Character sets conversion functionality
rcube_config Configuration class for Roundcube
rcube_contacts Model class for the local address book database
rcube_content_filter PHP stream filter to detect html/javascript code in attachments
rcube_csv2vcard CSV to vCard data converter
rcube_db Database independent query interface.
rcube_db_mssql Database independent query interface This is a wrapper for the PHP PDO
rcube_db_mysql Database independent query interface
rcube_db_oracle Database independent query interface
rcube_db_param Database query parameter
rcube_db_pgsql Database independent query interface This is a wrapper for the PHP PDO
rcube_db_sqlite Database independent query interface This is a wrapper for the PHP PDO
rcube_db_sqlsrv Database independent query interface This is a wrapper for the PHP PDO
rcube_dummy_plugin_api Lightweight plugin API class serving as a dummy if plugins are not enabled
rcube_enriched Class for Enriched to HTML conversion
rcube_html2text Converts HTML to formatted plain text
rcube_image Image resizer and converter
rcube_imap Interface class for accessing an IMAP server
rcube_imap_cache Interface class for accessing Roundcube messages cache
rcube_imap_generic PHP based wrapper class to connect to an IMAP server
rcube_imap_search Class to control search jobs on multiple IMAP folders.
rcube_imap_search_job Stackable item to run the search on a specific IMAP folder
rcube_ldap Model class to access an LDAP address directory
rcube_ldap_generic Model class to access an LDAP directories
rcube_message Logical representation of a mail message with all its data and related functions
rcube_message_header Struct representing an e-mail message header
rcube_message_header_sorter Class for sorting an array of rcube_message_header objects in a predetermined order.
rcube_message_part Class representing a message part
rcube_mime Class for parsing MIME messages
rcube_mime_decode Class for parsing MIME messages
rcube_output Class for output generation
rcube_plugin Plugin interface class
rcube_plugin_api The plugin loader and global API
rcube_result_index Class for accessing IMAP's SORT/SEARCH/ESEARCH result
rcube_result_multifolder Class holding a set of rcube_result_index instances that together form a result set of a multi-folder search
rcube_result_set Roundcube result set class
rcube_result_thread Class for accessing IMAP's THREAD result
rcube_session Abstract class to provide database supported session storage
rcube_session_db Class to provide database session storage
rcube_session_memcache Class to provide memcache session storage
rcube_session_memcached Class to provide memcached session storage
rcube_session_php Class to provide native php session storage
rcube_session_redis Class to provide redis session storage
rcube_smtp Class to provide SMTP functionality using PEAR Net_SMTP
rcube_spellchecker Helper class for spellchecking with GoogieSpell and PSpell support.
rcube_spellchecker_atd Spellchecking backend implementation to work with an After the Deadline service See http://www.afterthedeadline.com/ for more information
rcube_spellchecker_enchant Spellchecking backend implementation to work with Pspell
rcube_spellchecker_engine Interface class for a spell-checking backend
rcube_spellchecker_googie Spellchecking backend implementation to work with a Googiespell service
rcube_spellchecker_pspell Spellchecking backend implementation to work with Pspell
rcube_spoofchecker Helper class for spoofing detection.
rcube_storage Abstract class for accessing mail messages storage server
rcube_string_replacer Helper class for string replacements based on preg_replace_callback
rcube_text2html Converts plain text to HTML
rcube_tnef_decoder MS-TNEF format decoder based on code by: Graham Norbury <gnorbury@bondcar.com> Original design by: Thomas Boll <tb@boll.ch>, Mark Simpson <damned@world.std.com>
rcube_user Class representing a system user
rcube_utils Utility class providing common functions
rcube_vcard Logical representation of a vcard-based address record Provides functions to parse and export vCard data format
rcube_washtml Utility class providing HTML sanitizer

Constants

RCUBE_CHARSET

RCUBE_CHARSET = 'UTF-8'

RCUBE_CONFIG_DIR

RCUBE_CONFIG_DIR = \RCUBE_INSTALL_PATH . 'config/'

RCUBE_INSTALL_PATH

RCUBE_INSTALL_PATH = \RCUBE_LIB_DIR

RCUBE_LIB_DIR

RCUBE_LIB_DIR = __DIR__ . '/'

RCUBE_LOCALIZATION_DIR

RCUBE_LOCALIZATION_DIR = \RCUBE_INSTALL_PATH . 'localization/'

RCUBE_PLUGINS_DIR

RCUBE_PLUGINS_DIR = \RCUBE_INSTALL_PATH . 'plugins/'

RCUBE_PLUGINS_DIR

RCUBE_PLUGINS_DIR = \RCUBE_INSTALL_PATH . 'plugins/'

RCUBE_TEMP_FILE_PREFIX

RCUBE_TEMP_FILE_PREFIX = 'RCMTEMP'

RCUBE_VERSION

RCUBE_VERSION = '1.5.2'

Functions

abbreviate_string()

abbreviate_string(string  $str, int  $maxlength, string  $placeholder = '...', bool  $ending = false) : string

Truncate string if it is longer than the allowed length.

Replace the middle or the ending part of a string with a placeholder.

Parameters

string $str

Input string
int $maxlength

Max. length
string $placeholder

Replace removed chars with this
bool $ending

Set to True if string should be truncated from the end

Returns

string —

Abbreviated string

array_first()

array_first(array  $array) : mixed

Get first element from an array

Parameters

array $array

Input array

Returns

mixed —

First element if found, Null otherwise

array_keys_recursive()

array_keys_recursive(array  $array) : array

Get all keys from array (recursive).

Parameters

array $array

Input array

Returns

array —

List of array keys

asciiwords()

asciiwords(string  $str, bool  $css_id = false, string  $replace_with = '') : string

Remove all non-ascii and non-word chars except ., -, _

Parameters

string $str

A string
bool $css_id

The result may be used as CSS identifier
string $replace_with

Replacement character

Returns

string —

Clean string

format_email()

format_email(string  $email) : string

Format e-mail address

Parameters

string $email

E-mail address

Returns

string —

Formatted e-mail address

format_email_recipient()

format_email_recipient(string  $email, string  $name = '') : string

Compose a valid representation of name and e-mail address

Parameters

string $email

E-mail address
string $name

Person name

Returns

string —

Formatted string

get_offset_sec()

get_offset_sec(string  $str) : int

Returns number of seconds for a specified offset string.

Parameters

string $str

String representation of the offset (e.g. 20min, 5h, 2days, 1week)

Returns

int —

Number of seconds

get_offset_time()

get_offset_time(string  $offset_str, int  $factor = 1) : int

Create a unix timestamp with a specified offset from now.

Parameters

string $offset_str

String representation of the offset (e.g. 20min, 5h, 2days)
int $factor

Factor to multiply with the offset

Returns

int —

Unix timestamp

in_array_nocase()

in_array_nocase(string  $needle, mixed  $haystack) : bool

Similar function as in_array() but case-insensitive with multibyte support.

Parameters

string $needle

Needle value
mixed $haystack

Returns

bool —

True if found, False if not

is_ascii()

is_ascii(string  $str, bool  $control_chars = true) : bool

Check if a string contains only ascii characters

Parameters

string $str

String to check
bool $control_chars

Includes control characters

Returns

bool —

True if the string contains ASCII-only, False otherwise

parse_bytes()

parse_bytes(string  $str) : float

Parse a human readable string for a number of bytes.

Parameters

string $str

Input string

Returns

float —

Number of bytes

rcube_autoload()

rcube_autoload(string  $classname) : bool

Use PHP5 autoload for dynamic class loading

Parameters

string $classname

Class name

Returns

bool —

True when the class file has been found

slashify()

slashify(string  $str) : string

Make sure the string ends with a slash

Parameters

string $str

A string

Returns

string —

A string ending with a slash

unslashify()

unslashify(string  $str) : string

Remove slashes at the end of the string

Parameters

string $str

A string

Returns

string —

A string ending with no slash

version_parse()

version_parse(string  $version) : mixed

Fix version number so it can be used correctly in version_compare()

Parameters

string $version

Version number string

Returns

mixed —